<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - api.Connection</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/api.Access.html">api.Access</a></li>
	
	<li><a href="../symbols/api.Basic.html">api.Basic</a></li>
	
	<li><a href="../symbols/api.Channel.html">api.Channel</a></li>
	
	<li><a href="../symbols/api.Connection.html">api.Connection</a></li>
	
	<li><a href="../symbols/api.Dtx.html">api.Dtx</a></li>
	
	<li><a href="../symbols/api.Exchange.html">api.Exchange</a></li>
	
	<li><a href="../symbols/api.File.html">api.File</a></li>
	
	<li><a href="../symbols/api.Queue.html">api.Queue</a></li>
	
	<li><a href="../symbols/api.Stream.html">api.Stream</a></li>
	
	<li><a href="../symbols/api.Tunnel.html">api.Tunnel</a></li>
	
	<li><a href="../symbols/api.Tx.html">api.Tx</a></li>
	
	<li><a href="../symbols/handlers.html">handlers</a></li>
	
	<li><a href="../symbols/impl.html">impl</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class api.Connection
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/src_api_connection.js.html">connection.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class api.Connection.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/api.Connection.html#constructor">api.Connection</a></b>()
							</div>
							<div class="description">Work with socket connections.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class api.Connection.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Connection.html#close">close</a></b>(replyCode, replyText, classId, methodId)
								</div>
								<div class="description">Request a connection close.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Connection.html#closeOk">closeOk</a></b>()
								</div>
								<div class="description">Confirm a connection close.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Connection.html#open">open</a></b>(virtualHost, capabilities, insist)
								</div>
								<div class="description">Open connection to virtual host.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Connection.html#secureOk">secureOk</a></b>(response)
								</div>
								<div class="description">Security mechanism response.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Connection.html#startOk">startOk</a></b>(clientProperties, mechanism, response, locale)
								</div>
								<div class="description">Select security mechanism and locale.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Connection.html#tuneOk">tuneOk</a></b>(channelMax, frameMax, heartbeat)
								</div>
								<div class="description">Negotiate connection tuning parameters.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class api.Connection.">
					<caption>Event Summary</caption>
					<thead>
						<tr>
							<th scope="col">Event Attributes</th>
							<th scope="col">Event Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Connection.html#event:close">close</a></b>(replyCode, replyText, classId, methodId)
								</div>
								<div class="description">Request a connection close.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Connection.html#event:closeOk">closeOk</a></b>()
								</div>
								<div class="description">Confirm a connection close.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Connection.html#event:openOk">openOk</a></b>(knownHosts)
								</div>
								<div class="description">Signal that the connection is ready.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Connection.html#event:redirect">redirect</a></b>(host, knownHosts)
								</div>
								<div class="description">Asks the client to use a different server.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Connection.html#event:secure">secure</a></b>(challenge)
								</div>
								<div class="description">Security mechanism challenge.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Connection.html#event:start">start</a></b>(versionMajor, versionMinor, serverProperties, mechanisms, locales)
								</div>
								<div class="description">Start connection negotiation.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Connection.html#event:tune">tune</a></b>(channelMax, frameMax, heartbeat)
								</div>
								<div class="description">Propose connection tuning parameters.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>api.Connection</b>()
				</div>
				
				<div class="description">
					Work with socket connections.

The connection class provides methods for a client to establish a
  network connection to a server, and for both peers to operate the
  connection thereafter.
					
				</div>
				
				
				
				
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="close"> </a>
					<div class="fixedFont">
					
					
					<b>close</b>(replyCode, replyText, classId, methodId)
					
					</div>
					<div class="description">
						Request a connection close.

This method indicates that the sender wants to close the connection.
    This may be due to internal conditions (e.g. a forced shut-down) or
    due to an error handling a specific method, i.e. an exception.  When
    a close is due to an exception, the sender provides the class and
    method id of the method which caused the exception.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>replyCode</b>
									
								</dt>
								<dd>The reply code. The AMQ reply codes are defined in AMQ RFC 011.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>replyText</b>
									
								</dt>
								<dd>The localised reply text.  This text can be logged as an aid to
  resolving issues.</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>classId</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>methodId</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="closeOk"> </a>
					<div class="fixedFont">
					
					
					<b>closeOk</b>()
					
					</div>
					<div class="description">
						Confirm a connection close.

This method confirms a Connection.Close method and tells the
    recipient that it is safe to release resources for the connection
    and close the socket.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="open"> </a>
					<div class="fixedFont">
					
					
					<b>open</b>(virtualHost, capabilities, insist)
					
					</div>
					<div class="description">
						Open connection to virtual host.

This method opens a connection to a virtual host, which is a
    collection of resources, and acts to separate multiple application
    domains within a server.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>virtualHost</b>
									
								</dt>
								<dd>Must start with a slash "/" and continue with path names
  separated by slashes. A path name consists of any combination
  of at least one of [A-Za-z0-9] plus zero or more of [.-_+!=:].</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>capabilities</b>
									
								</dt>
								<dd>The client may specify a number of capability names, delimited by
      spaces.  The server can use this string to how to process the
      client's connection request.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>insist</b>
									
								</dt>
								<dd>In a configuration with multiple load-sharing servers, the server
      may respond to a Connection.Open method with a Connection.Redirect.
      The insist option tells the server that the client is insisting on
      a connection to the specified server.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="secureOk"> </a>
					<div class="fixedFont">
					
					
					<b>secureOk</b>(response)
					
					</div>
					<div class="description">
						Security mechanism response.

This method attempts to authenticate, passing a block of SASL data
    for the security mechanism at the server side.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>response</b>
									
								</dt>
								<dd>A block of opaque data passed to the security mechanism.  The contents
      of this data are defined by the SASL security mechanism.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="startOk"> </a>
					<div class="fixedFont">
					
					
					<b>startOk</b>(clientProperties, mechanism, response, locale)
					
					</div>
					<div class="description">
						Select security mechanism and locale.

This method selects a SASL security mechanism. ASL uses SASL
    (RFC2222) to negotiate authentication and encryption.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>clientProperties</b>
									
								</dt>
								<dd>This string provides a set of peer properties, used for
identification, debugging, and general information.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>mechanism</b>
									
								</dt>
								<dd>A single security mechanisms selected by the client, which must be
      one of those specified by the server.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>response</b>
									
								</dt>
								<dd>A block of opaque data passed to the security mechanism. The contents
      of this data are defined by the SASL security mechanism.  For the
      PLAIN security mechanism this is defined as a field table holding
      two fields, LOGIN and PASSWORD.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>locale</b>
									
								</dt>
								<dd>A single message local selected by the client, which must be one
      of those specified by the server.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="tuneOk"> </a>
					<div class="fixedFont">
					
					
					<b>tuneOk</b>(channelMax, frameMax, heartbeat)
					
					</div>
					<div class="description">
						Negotiate connection tuning parameters.

This method sends the client's connection tuning parameters to the
    server. Certain fields are negotiated, others provide capability
    information.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>channelMax</b>
									
								</dt>
								<dd>The maximum total number of channels that the client will use
      per connection.  May not be higher than the value specified by
      the server.</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>frameMax</b>
									
								</dt>
								<dd>The largest frame size that the client and server will use for
      the connection.  Zero means that the client does not impose any
      specific limit but may reject very large frames if it cannot
      allocate resources for them.  Note that the frame-max limit
      applies principally to content frames, where large contents
      can be broken into frames of arbitrary size.</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>heartbeat</b>
									
								</dt>
								<dd>The delay, in seconds, of the connection heartbeat that the client
      wants. Zero means the client does not want a heartbeat.</dd>
							
							</dl>
						
						
						
						
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
				<div class="sectionTitle">
					Event Detail
				</div>
				
					<a name="event:close"> </a>
					<div class="fixedFont">
					
					
					<b>close</b>(replyCode, replyText, classId, methodId)
					
					</div>
					<div class="description">
						Request a connection close.

This method indicates that the sender wants to close the connection.
    This may be due to internal conditions (e.g. a forced shut-down) or
    due to an error handling a specific method, i.e. an exception.  When
    a close is due to an exception, the sender provides the class and
    method id of the method which caused the exception.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>replyCode</b>
									
								</dt>
								<dd>The reply code. The AMQ reply codes are defined in AMQ RFC 011.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>replyText</b>
									
								</dt>
								<dd>The localised reply text.  This text can be logged as an aid to
  resolving issues.</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>classId</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>methodId</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:closeOk"> </a>
					<div class="fixedFont">
					
					
					<b>closeOk</b>()
					
					</div>
					<div class="description">
						Confirm a connection close.

This method confirms a Connection.Close method and tells the
    recipient that it is safe to release resources for the connection
    and close the socket.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:openOk"> </a>
					<div class="fixedFont">
					
					
					<b>openOk</b>(knownHosts)
					
					</div>
					<div class="description">
						Signal that the connection is ready.

This method signals to the client that the connection is ready for
    use.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>knownHosts</b>
									
								</dt>
								<dd>Specifies the list of equivalent or alternative hosts that the server
knows about, which will normally include the current server itself.
Clients can cache this information and use it when reconnecting to a
server after a failure.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:redirect"> </a>
					<div class="fixedFont">
					
					
					<b>redirect</b>(host, knownHosts)
					
					</div>
					<div class="description">
						Asks the client to use a different server.

This method redirects the client to another server, based on the
    requested virtual host and/or capabilities.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>host</b>
									
								</dt>
								<dd>Specifies the server to connect to.  This is an IP address or a
      DNS name, optionally followed by a colon and a port number. If
      no port number is specified, the client should use the default
      port number for the protocol.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>knownHosts</b>
									
								</dt>
								<dd>Specifies the list of equivalent or alternative hosts that the server
knows about, which will normally include the current server itself.
Clients can cache this information and use it when reconnecting to a
server after a failure.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:secure"> </a>
					<div class="fixedFont">
					
					
					<b>secure</b>(challenge)
					
					</div>
					<div class="description">
						Security mechanism challenge.

The SASL protocol works by exchanging challenges and responses until
    both peers have received sufficient information to authenticate each
    other.  This method challenges the client to provide more information.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>challenge</b>
									
								</dt>
								<dd>Challenge information, a block of opaque binary data passed to
      the security mechanism.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:start"> </a>
					<div class="fixedFont">
					
					
					<b>start</b>(versionMajor, versionMinor, serverProperties, mechanisms, locales)
					
					</div>
					<div class="description">
						Start connection negotiation.

This method starts the connection negotiation process by telling
    the client the protocol version that the server proposes, along
    with a list of security mechanisms which the client can use for
    authentication.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>versionMajor</b>
									
								</dt>
								<dd>The protocol major version that the server agrees to use, which
      cannot be higher than the client's major version.</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>versionMinor</b>
									
								</dt>
								<dd>The protocol minor version that the server agrees to use, which
      cannot be higher than the client's minor version.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>serverProperties</b>
									
								</dt>
								<dd>This string provides a set of peer properties, used for
identification, debugging, and general information.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>mechanisms</b>
									
								</dt>
								<dd>A list of the security mechanisms that the server supports, delimited
      by spaces.  Currently ASL supports these mechanisms: PLAIN.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>locales</b>
									
								</dt>
								<dd>A list of the message locales that the server supports, delimited
      by spaces.  The locale defines the language in which the server
      will send reply texts.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:tune"> </a>
					<div class="fixedFont">
					
					
					<b>tune</b>(channelMax, frameMax, heartbeat)
					
					</div>
					<div class="description">
						Propose connection tuning parameters.

This method proposes a set of connection configuration values
    to the client.  The client can accept and/or adjust these.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>channelMax</b>
									
								</dt>
								<dd>The maximum total number of channels that the server allows
      per connection. Zero means that the server does not impose a
      fixed limit, but the number of allowed channels may be limited
      by available server resources.</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>frameMax</b>
									
								</dt>
								<dd>The largest frame size that the server proposes for the
      connection. The client can negotiate a lower value.  Zero means
      that the server does not impose any specific limit but may reject
      very large frames if it cannot allocate resources for them.</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>heartbeat</b>
									
								</dt>
								<dd>The delay, in seconds, of the connection heartbeat that the server
      wants.  Zero means the server does not want a heartbeat.</dd>
							
							</dl>
						
						
						
						
						
						
						

					
				
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Thu Nov 04 2010 22:16:21 GMT+0200 (EET)
		</div>
	</body>
</html>
